Add docs build options and theme requirements #818
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JelleZijlstra
approved these changes
Jun 17, 2021
stefanv
approved these changes
Jun 17, 2021
There was a problem hiding this comment.
This looks great, thanks @shannonzhu.
My only recommendation would be that we use MyST markdown as the markup format to make it easier for people to contribute to the docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Makefile rules to pull in python docs theme requirements in a venv and shortcut sphinx builds. Not confident on the Makefile details - used python/docs Sphinx builds as a reference here.
Verified that
make venvsuccessfully builds a virtual environment with Sphinx and the correct theming dependencies installed, andmake htmlcreates a page successfully.Output: https://gist.github.com/shannonzhu/faa9e20e34cd0a785ea9098aed69ae56